NAVNavbar
Logo
cURL php NodeJS Python cSharp

OnPage API Microdata

‌‌
This endpoint is designed to validate structured JSON-LD data and Microdata. Using this function you will obtain microdata available on the specified page of the target website and detailed results of its validation.
To use this endpoint, set the validate_micromarkup parameter to true in the POST request to OnPage API.

Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard

<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
$client = new RestClient($api_url, null, 'login', 'password');

$post_array = array();
// simple way to get a result
$post_array[] = array(
   "id" => "02241700-1535-0216-0000-034137259bc1",
   "url" => "https://dataforseo.com/apis"
);
try {
   // POST /v3/on_page/microdata
   // the full list of possible parameters is available in documentation
   $result = $client->post('/v3/on_page/microdata', $post_array);
   print_r($result);
   // do something with post result
} catch (RestClientException $e) {
   echo "n";
   print "HTTP code: {$e->getHttpCode()}n";
   print "Error code: {$e->getCode()}n";
   print "Message: {$e->getMessage()}n";
   print  $e->getTraceAsString();
   echo "n";
}
$client = null;
?>

The above command returns JSON structured like this:

{
  "version": "0.1.20221214",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "0.0344 sec.",
  "cost": 0,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "01161532-1535-0216-0000-9b351e1ad02c",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "0.0196 sec.",
      "cost": 0,
      "result_count": 1,
      "path": [
        "v3",
        "on_page",
        "microdata"
      ],
      "data": {
        "api": "on_page",
        "function": "microdata",
        "url": "https://dataforseo.com/apis",
        "target": "dataforseo.com",
        "max_crawl_pages": 10,
        "enable_content_parsing": true,
        "validate_micromarkup": true
      },
      "result": [
        {
          "crawl_progress": "finished",
          "crawl_status": {
            "max_crawl_pages": 10,
            "pages_in_queue": 0,
            "pages_crawled": 10
          },
          "test_summary": {
            "fatal": 0,
            "error": 2,
            "warning": 6,
            "info": 5
          },
          "items_count": 14,
          "items": [
            {
              "type": "json_ld",
              "inspection_info": {
                "types": [
                  "Place"
                ],
                "fields": [
                  {
                    "name": "@type",
                    "types": null,
                    "value": "Place",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "@id",
                    "types": null,
                    "value": "https://dataforseo.com/#place",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "address",
                    "types": [
                      "Thing"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@type",
                        "types": null,
                        "value": "PostalAddress",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "streetAddress",
                        "types": null,
                        "value": "Vesivärava tn 50-201, Kesklinna linnaosa",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "addressLocality",
                        "types": null,
                        "value": "Tallinn,",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "addressRegion",
                        "types": null,
                        "value": "Harju maakond",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "postalCode",
                        "types": null,
                        "value": "10152",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "addressCountry",
                        "types": null,
                        "value": "Estonia",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "name",
                    "types": null,
                    "value": null,
                    "test_results": {
                      "level": "warning",
                      "message": "missing field 'name'"
                    },
                    "fields": null
                  }
                ]
              }
            },
            {
              "type": "json_ld",
              "inspection_info": {
                "types": [
                  "LegalService"
                ],
                "fields": [
                  {
                    "name": "@type",
                    "types": null,
                    "value": "LegalService",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "@type",
                    "types": null,
                    "value": "Organization",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "@id",
                    "types": null,
                    "value": "https://dataforseo.com/#organization",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "name",
                    "types": null,
                    "value": "DATAFORSEO",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "url",
                    "types": null,
                    "value": "https://dataforseo.com",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "email",
                    "types": null,
                    "value": "info@dataforseo.com",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "address",
                    "types": [
                      "PostalAddress"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@type",
                        "types": null,
                        "value": "PostalAddress",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "streetAddress",
                        "types": null,
                        "value": "Vesivärava tn 50-201, Kesklinna linnaosa",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "addressLocality",
                        "types": null,
                        "value": "Tallinn,",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "addressRegion",
                        "types": null,
                        "value": "Harju maakond",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "postalCode",
                        "types": null,
                        "value": "10152",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "addressCountry",
                        "types": null,
                        "value": "Estonia",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "logo",
                    "types": [
                      "Thing"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@type",
                        "types": null,
                        "value": "ImageObject",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "@id",
                        "types": null,
                        "value": "https://dataforseo.com/#logo",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "url",
                        "types": null,
                        "value": "https://dataforseo.com/wp-content/uploads/2016/11/logo_data_for_seo_429.png",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "contentUrl",
                        "types": null,
                        "value": "https://dataforseo.com/wp-content/uploads/2016/11/logo_data_for_seo_429.png",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "caption",
                        "types": null,
                        "value": "DATAFORSEO",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "inLanguage",
                        "types": null,
                        "value": "en-US",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "width",
                        "types": null,
                        "value": "429",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "height",
                        "types": null,
                        "value": "80",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "priceRange",
                    "types": null,
                    "value": "$$$",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "openingHours",
                    "types": null,
                    "value": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday 09:00-17:00",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "location",
                    "types": [
                      "Thing"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@id",
                        "types": null,
                        "value": "https://dataforseo.com/#place",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "image",
                    "types": [
                      "Thing"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@id",
                        "types": null,
                        "value": "https://dataforseo.com/#logo",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "telephone",
                    "types": null,
                    "value": "+3726027642",
                    "test_results": null,
                    "fields": null
                  }
                ]
              }
            },
            {
              "type": "json_ld",
              "inspection_info": {
                "types": [
                  "Organization"
                ],
                "fields": [
                  {
                    "name": "@type",
                    "types": null,
                    "value": "LegalService",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "@type",
                    "types": null,
                    "value": "Organization",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "@id",
                    "types": null,
                    "value": "https://dataforseo.com/#organization",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "name",
                    "types": null,
                    "value": "DATAFORSEO",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "url",
                    "types": null,
                    "value": "https://dataforseo.com",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "email",
                    "types": null,
                    "value": "info@dataforseo.com",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "address",
                    "types": [
                      "Thing"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@type",
                        "types": null,
                        "value": "PostalAddress",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "streetAddress",
                        "types": null,
                        "value": "Vesivärava tn 50-201, Kesklinna linnaosa",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "addressLocality",
                        "types": null,
                        "value": "Tallinn,",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "addressRegion",
                        "types": null,
                        "value": "Harju maakond",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "postalCode",
                        "types": null,
                        "value": "10152",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "addressCountry",
                        "types": null,
                        "value": "Estonia",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "logo",
                    "types": [
                      "ImageObject"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@type",
                        "types": null,
                        "value": "ImageObject",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "@id",
                        "types": null,
                        "value": "https://dataforseo.com/#logo",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "url",
                        "types": null,
                        "value": "https://dataforseo.com/wp-content/uploads/2016/11/logo_data_for_seo_429.png",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "contentUrl",
                        "types": null,
                        "value": "https://dataforseo.com/wp-content/uploads/2016/11/logo_data_for_seo_429.png",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "caption",
                        "types": null,
                        "value": "DATAFORSEO",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "inLanguage",
                        "types": null,
                        "value": "en-US",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "width",
                        "types": null,
                        "value": "429",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "height",
                        "types": null,
                        "value": "80",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "priceRange",
                    "types": null,
                    "value": "$$$",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "openingHours",
                    "types": null,
                    "value": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday 09:00-17:00",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "location",
                    "types": [
                      "Thing"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@id",
                        "types": null,
                        "value": "https://dataforseo.com/#place",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "image",
                    "types": [
                      "Thing"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@id",
                        "types": null,
                        "value": "https://dataforseo.com/#logo",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "telephone",
                    "types": null,
                    "value": "+3726027642",
                    "test_results": null,
                    "fields": null
                  }
                ]
              }
            },
            {
              "type": "json_ld",
              "inspection_info": {
                "types": [
                  "WebSite"
                ],
                "fields": [
                  {
                    "name": "@type",
                    "types": null,
                    "value": "WebSite",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "@id",
                    "types": null,
                    "value": "https://dataforseo.com/#website",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "url",
                    "types": null,
                    "value": "https://dataforseo.com",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "name",
                    "types": null,
                    "value": "DATAFORSEO",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "publisher",
                    "types": [
                      "Thing"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@id",
                        "types": null,
                        "value": "https://dataforseo.com/#organization",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "inLanguage",
                    "types": null,
                    "value": "en-US",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "potentialAction",
                    "types": null,
                    "value": null,
                    "test_results": {
                      "level": "error",
                      "message": "missing field 'potentialAction'"
                    },
                    "fields": null
                  }
                ]
              }
            },
            {
              "type": "json_ld",
              "inspection_info": {
                "types": [
                  "BreadcrumbList"
                ],
                "fields": [
                  {
                    "name": "@type",
                    "types": null,
                    "value": "BreadcrumbList",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "@id",
                    "types": null,
                    "value": "https://dataforseo.com/apis#breadcrumb",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "itemListElement",
                    "types": [
                      "ListItem"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@type",
                        "types": null,
                        "value": "ListItem",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "position",
                        "types": null,
                        "value": "1",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "item",
                        "types": [
                          "Thing"
                        ],
                        "value": null,
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "name",
                        "types": null,
                        "value": null,
                        "test_results": {
                          "level": "warning",
                          "message": "missing field 'name'"
                        },
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "itemListElement",
                    "types": [
                      "ListItem"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@type",
                        "types": null,
                        "value": "ListItem",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "position",
                        "types": null,
                        "value": "2",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "item",
                        "types": [
                          "Thing"
                        ],
                        "value": null,
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "name",
                        "types": null,
                        "value": null,
                        "test_results": {
                          "level": "warning",
                          "message": "missing field 'name'"
                        },
                        "fields": null
                      }
                    ]
                  }
                ]
              }
            },
            {
              "type": "json_ld",
              "inspection_info": {
                "types": [
                  "WebPage"
                ],
                "fields": [
                  {
                    "name": "@type",
                    "types": null,
                    "value": "WebPage",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "@id",
                    "types": null,
                    "value": "https://dataforseo.com/apis#webpage",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "url",
                    "types": null,
                    "value": "https://dataforseo.com/apis",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "name",
                    "types": null,
                    "value": "DataForSEO APIs – Powerful Data Solutions for SEO and SEM",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "datePublished",
                    "types": null,
                    "value": "05/12/2020 09:34:37",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "dateModified",
                    "types": null,
                    "value": "12/15/2022 16:58:40",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "isPartOf",
                    "types": [
                      "Thing"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@id",
                        "types": null,
                        "value": "https://dataforseo.com/#website",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "inLanguage",
                    "types": null,
                    "value": "en-US",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "breadcrumb",
                    "types": [
                      "Thing"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@id",
                        "types": null,
                        "value": "https://dataforseo.com/apis#breadcrumb",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "lastReviewed",
                    "types": null,
                    "value": null,
                    "test_results": {
                      "level": "warning",
                      "message": "missing field 'lastReviewed'"
                    },
                    "fields": null
                  }
                ]
              }
            },
            {
              "type": "json_ld",
              "inspection_info": {
                "types": [
                  "Offer"
                ],
                "fields": [
                  {
                    "name": "@type",
                    "types": null,
                    "value": "Offer",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "price",
                    "types": null,
                    "value": "50",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "priceCurrency",
                    "types": null,
                    "value": "usd",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "availability",
                    "types": null,
                    "value": "InStock",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "category",
                    "types": null,
                    "value": null,
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "eligibleRegion",
                    "types": null,
                    "value": null,
                    "test_results": null,
                    "fields": null
                  }
                ]
              }
            },
            {
              "type": "json_ld",
              "inspection_info": {
                "types": [
                  "Place"
                ],
                "fields": [
                  {
                    "name": "@type",
                    "types": null,
                    "value": "Place",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "@id",
                    "types": null,
                    "value": "https://dataforseo.com/#place",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "address",
                    "types": [
                      "Thing"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@type",
                        "types": null,
                        "value": "PostalAddress",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "streetAddress",
                        "types": null,
                        "value": "Vesivärava tn 50-201, Kesklinna linnaosa",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "addressLocality",
                        "types": null,
                        "value": "Tallinn,",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "addressRegion",
                        "types": null,
                        "value": "Harju maakond",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "postalCode",
                        "types": null,
                        "value": "10152",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "addressCountry",
                        "types": null,
                        "value": "Estonia",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "name",
                    "types": null,
                    "value": null,
                    "test_results": null,
                    "fields": null
                  }
                ]
              }
            },
            {
              "type": "json_ld",
              "inspection_info": {
                "types": [
                  "LegalService"
                ],
                "fields": [
                  {
                    "name": "@type",
                    "types": null,
                    "value": "LegalService",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "@type",
                    "types": null,
                    "value": "Organization",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "@id",
                    "types": null,
                    "value": "https://dataforseo.com/#organization",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "name",
                    "types": null,
                    "value": "DATAFORSEO",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "url",
                    "types": null,
                    "value": "https://dataforseo.com",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "email",
                    "types": null,
                    "value": "info@dataforseo.com",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "address",
                    "types": [
                      "PostalAddress"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@type",
                        "types": null,
                        "value": "PostalAddress",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "streetAddress",
                        "types": null,
                        "value": "Vesivärava tn 50-201, Kesklinna linnaosa",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "addressLocality",
                        "types": null,
                        "value": "Tallinn,",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "addressRegion",
                        "types": null,
                        "value": "Harju maakond",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "postalCode",
                        "types": null,
                        "value": "10152",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "addressCountry",
                        "types": null,
                        "value": "Estonia",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "logo",
                    "types": [
                      "Thing"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@type",
                        "types": null,
                        "value": "ImageObject",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "@id",
                        "types": null,
                        "value": "https://dataforseo.com/#logo",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "url",
                        "types": null,
                        "value": "https://dataforseo.com/wp-content/uploads/2016/11/logo_data_for_seo_429.png",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "contentUrl",
                        "types": null,
                        "value": "https://dataforseo.com/wp-content/uploads/2016/11/logo_data_for_seo_429.png",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "caption",
                        "types": null,
                        "value": "DATAFORSEO",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "inLanguage",
                        "types": null,
                        "value": "en-US",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "width",
                        "types": null,
                        "value": "429",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "height",
                        "types": null,
                        "value": "80",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "priceRange",
                    "types": null,
                    "value": "$$$",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "openingHours",
                    "types": null,
                    "value": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday 09:00-17:00",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "location",
                    "types": [
                      "Thing"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@id",
                        "types": null,
                        "value": "https://dataforseo.com/#place",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "image",
                    "types": [
                      "Thing"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@id",
                        "types": null,
                        "value": "https://dataforseo.com/#logo",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "telephone",
                    "types": null,
                    "value": "+3726027642",
                    "test_results": null,
                    "fields": null
                  }
                ]
              }
            },
            {
              "type": "json_ld",
              "inspection_info": {
                "types": [
                  "Organization"
                ],
                "fields": [
                  {
                    "name": "@type",
                    "types": null,
                    "value": "LegalService",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "@type",
                    "types": null,
                    "value": "Organization",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "@id",
                    "types": null,
                    "value": "https://dataforseo.com/#organization",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "name",
                    "types": null,
                    "value": "DATAFORSEO",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "url",
                    "types": null,
                    "value": "https://dataforseo.com",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "email",
                    "types": null,
                    "value": "info@dataforseo.com",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "address",
                    "types": [
                      "Thing"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@type",
                        "types": null,
                        "value": "PostalAddress",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "streetAddress",
                        "types": null,
                        "value": "Vesivärava tn 50-201, Kesklinna linnaosa",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "addressLocality",
                        "types": null,
                        "value": "Tallinn,",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "addressRegion",
                        "types": null,
                        "value": "Harju maakond",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "postalCode",
                        "types": null,
                        "value": "10152",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "addressCountry",
                        "types": null,
                        "value": "Estonia",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "logo",
                    "types": [
                      "ImageObject"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@type",
                        "types": null,
                        "value": "ImageObject",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "@id",
                        "types": null,
                        "value": "https://dataforseo.com/#logo",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "url",
                        "types": null,
                        "value": "https://dataforseo.com/wp-content/uploads/2016/11/logo_data_for_seo_429.png",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "contentUrl",
                        "types": null,
                        "value": "https://dataforseo.com/wp-content/uploads/2016/11/logo_data_for_seo_429.png",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "caption",
                        "types": null,
                        "value": "DATAFORSEO",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "inLanguage",
                        "types": null,
                        "value": "en-US",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "width",
                        "types": null,
                        "value": "429",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "height",
                        "types": null,
                        "value": "80",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "priceRange",
                    "types": null,
                    "value": "$$$",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "openingHours",
                    "types": null,
                    "value": "Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday 09:00-17:00",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "location",
                    "types": [
                      "Thing"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@id",
                        "types": null,
                        "value": "https://dataforseo.com/#place",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "image",
                    "types": [
                      "Thing"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@id",
                        "types": null,
                        "value": "https://dataforseo.com/#logo",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "telephone",
                    "types": null,
                    "value": "+3726027642",
                    "test_results": null,
                    "fields": null
                  }
                ]
              }
            },
            {
              "type": "json_ld",
              "inspection_info": {
                "types": [
                  "WebSite"
                ],
                "fields": [
                  {
                    "name": "@type",
                    "types": null,
                    "value": "WebSite",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "@id",
                    "types": null,
                    "value": "https://dataforseo.com/#website",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "url",
                    "types": null,
                    "value": "https://dataforseo.com",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "name",
                    "types": null,
                    "value": "DATAFORSEO",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "publisher",
                    "types": [
                      "Thing"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@id",
                        "types": null,
                        "value": "https://dataforseo.com/#organization",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "inLanguage",
                    "types": null,
                    "value": "en-US",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "potentialAction",
                    "types": null,
                    "value": null,
                    "test_results": {
                      "level": "error",
                      "message": "missing field 'potentialAction'"
                    },
                    "fields": null
                  }
                ]
              }
            },
            {
              "type": "json_ld",
              "inspection_info": {
                "types": [
                  "BreadcrumbList"
                ],
                "fields": [
                  {
                    "name": "@type",
                    "types": null,
                    "value": "BreadcrumbList",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "@id",
                    "types": null,
                    "value": "https://dataforseo.com/apis#breadcrumb",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "itemListElement",
                    "types": [
                      "ListItem"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@type",
                        "types": null,
                        "value": "ListItem",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "position",
                        "types": null,
                        "value": "1",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "item",
                        "types": [
                          "Thing"
                        ],
                        "value": null,
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "name",
                        "types": null,
                        "value": null,
                        "test_results": {
                          "level": "warning",
                          "message": "missing field 'name'"
                        },
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "itemListElement",
                    "types": [
                      "ListItem"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@type",
                        "types": null,
                        "value": "ListItem",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "position",
                        "types": null,
                        "value": "2",
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "item",
                        "types": [
                          "Thing"
                        ],
                        "value": null,
                        "test_results": null,
                        "fields": null
                      },
                      {
                        "name": "name",
                        "types": null,
                        "value": null,
                        "test_results": {
                          "level": "warning",
                          "message": "missing field 'name'"
                        },
                        "fields": null
                      }
                    ]
                  }
                ]
              }
            },
            {
              "type": "json_ld",
              "inspection_info": {
                "types": [
                  "WebPage"
                ],
                "fields": [
                  {
                    "name": "@type",
                    "types": null,
                    "value": "WebPage",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "@id",
                    "types": null,
                    "value": "https://dataforseo.com/apis#webpage",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "url",
                    "types": null,
                    "value": "https://dataforseo.com/apis",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "name",
                    "types": null,
                    "value": "DataForSEO APIs – Powerful Data Solutions for SEO and SEM",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "datePublished",
                    "types": null,
                    "value": "05/12/2020 09:34:37",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "dateModified",
                    "types": null,
                    "value": "12/15/2022 16:58:40",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "isPartOf",
                    "types": [
                      "Thing"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@id",
                        "types": null,
                        "value": "https://dataforseo.com/#website",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "inLanguage",
                    "types": null,
                    "value": "en-US",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "breadcrumb",
                    "types": [
                      "Thing"
                    ],
                    "value": null,
                    "test_results": null,
                    "fields": [
                      {
                        "name": "@id",
                        "types": null,
                        "value": "https://dataforseo.com/apis#breadcrumb",
                        "test_results": null,
                        "fields": null
                      }
                    ]
                  },
                  {
                    "name": "lastReviewed",
                    "types": null,
                    "value": null,
                    "test_results": null,
                    "fields": null
                  }
                ]
              }
            },
            {
              "type": "json_ld",
              "inspection_info": {
                "types": [
                  "Offer"
                ],
                "fields": [
                  {
                    "name": "@type",
                    "types": null,
                    "value": "Offer",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "price",
                    "types": null,
                    "value": "50",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "priceCurrency",
                    "types": null,
                    "value": "usd",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "availability",
                    "types": null,
                    "value": "InStock",
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "category",
                    "types": null,
                    "value": null,
                    "test_results": null,
                    "fields": null
                  },
                  {
                    "name": "eligibleRegion",
                    "types": null,
                    "value": null,
                    "test_results": null,
                    "fields": null
                  }
                ]
              }
            }
          ]
        }
      ]
    }
  ]
}

All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array.

Description of the fields for setting a task:

Field name Type Description
id string ID of the task
required field
you can get this ID in the response of the Task POST endpoint
example:
"07131248-1535-0216-1000-17384017ad04"
url string resource URL
required field
you can get this URL in the response of the Pages endpoint
example:
https://dataforseo.com/apis
tag string user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response

‌‌‌‌‌‌
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.

Description of the fields in the results array:

Field name Type Description
version string the current version of the API
status_code integer general status code
you can find the full list of the response codes here
Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
status_message string general informational message
you can find the full list of general informational messages here
time string execution time, seconds
cost float total tasks cost, USD
tasks_count integer the number of tasks in the tasks array
tasks_error integer the number of tasks in the tasks array returned with an error
tasks array array of tasks
        id string task identifier
unique task identifier in our system in the UUID format
        status_code integer status code of the task
generated by DataForSEO; can be within the following range: 10000-60000
you can find the full list of the response codes here
        status_message string informational message of the task
you can find the full list of general informational messages here
        time string execution time, seconds
        cost float cost of the task, USD
        result_count integer number of elements in the result array
        path array URL path
        data object contains the same parameters that you specified in the POST request
        result array array of results
            crawl_progress string status of the crawling session
possible values: in_progress, finished
            crawl_status object details of the crawling session
               max_crawl_pages integer maximum number of pages to crawl
indicates the max_crawl_pages limit you specified when setting a task
               pages_in_queue integer number of pages that are currently in the crawling queue
               pages_crawled integer number of crawled pages
            test_summary object microdata validation test results
               fatal integer number of fatal microdata errors
               error integer number of serious microdata errors
               warning integer number of microdata warnings
               info integer number of microdata information flags
            items_count integer number of items in the results array
            items array items array
            ‘json_ld’
              type string type of the item = ‘json_ld’
              inspection_info object information related to microdata validation
                  types array parent microdata types
for a full list of available types, please visit schema.org
                  fields array microdata fields
an array of objects containing data fields related to the certain microdata type
                      name string field name
name of the data field
                      types array list of microdata sub-types
                      value array microdata value
microdata value specified on a target web page
                      test_results object microdata validation test results
sub-type microdata test results that contain detected errors and related messages
                          level string level of microdata error
can take the following values: fatal, error, warning, info
                          message string message associated with an error
message providing the details of the detected error
                      fields array microdata fields
an array of objects containing data fields related to the certain microdata type

‌‌